POST Audio Search

Overview

---

The following table contains important information about the POST method for retrieving audios with pagination.

POST Audio
Method	POST
URL or Endpoint	/api/v1/projectId/audios/search
Parameters	projectId
Body	Check request body below.

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
projectId	Yes	string	Unique ID of the project.

Request Body

{
  "page": 0,
  "searchAfter": [
    null
  ],
  "folderId": 0,
  "folderView": true,
  "onlyReady": true,
  "onlyPublishedAudios": true,
  "key": "string",
  "value": "string",
  "author": "string",
  "podcastId": "string",
  "search": "string",
  "order": "string",
  "insertDate": "2026-02-16T13:14:35.162Z",
  "take": 0
}

Parameter Name	Mandatory	Type	Description
page	No	integer	The page number to retrieve in a paginated result set. Typically starts from 0.
searchAfter	No	array	An array of values used for cursor-based pagination. Use the last value from the previous page for the next page.
folderId	No	integer	ID of the folder to filter audios by. Use 0 or omit for no folder filtering.
folderView	No	boolean	Indicates whether the response should be filtered or formatted according to folder view.
onlyReady	No	boolean	Filter to include only audios that are ready for playback or processing.
onlyPublishedAudios	No	boolean	Filter to include only audios that are published and visible to users.
key	No	string	Custom key used for filtering audio properties.
value	No	string	Value corresponding to the key used for property filtering.
author	No	string	Filter audios by the author.
podcastId	No	string	ID of a podcast to filter audios belonging to it.
search	No	string	Search term to filter audios by.
order	No	string	Sorting order for the results.
insertDate	No	Date	Filter audios by their insertion date.
take	No	integer	The number of audios to retrieve per request.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "currentPage": 1,
    "totalPages": 8,
    "pageSize": 10,
    "totalCount": 72,
    "searchAfter": [
        1768837792185,
        8284
    ],
    "items": [
      {
        "title": "{title}",
        "publicId": "{audioId}",
        "author": "{author}",
        "audioAuthor": "{audioAuthor}",
        "status": "{Status}",
        "publishDate": "2026-02-05T22:35:00",
        "updateDate": "2026-02-05T22:35:00",
        "canEmbed": true,
        "thumbnail": null,
        "duration": 15.072653,
        "folderId": null,
        "folder": null,
        "progress": 0,
        "estimatedFinishTime": "",
        "showEncodingProgress": false,
        "errorId": null,
        "error": null,
        "highlight": {}
      }
    ]
  },
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false
errors	array[string]	Indicates if there was an error
messages	array[string]	Returns the response message from back-end
result	array[Object]	Returns the response object
currentPage	integer	Number of the current page
totalPages	integer	Number of the total page
pageSize	integer	The size of the page
totalCount	integer	Number of the total records
searchAfter	array	An array of values used for cursor-based pagination. Use the last value from the previous page for the next page.
items	array[Object]	Array with records
title	string	Title of the audio
publicId	string	Unique identifier of the audio
author	string	Author of the audio
audioAuthor	string	Author of the audio content
status	string	Status of the audio
publishDate	Date	Publish date of the audio
updateDate	Date	Update date of the audio
canEmbed	boolean	Indicates if the audio can be embedded
thumbnail	string	Thumbnail of the audio
duration	double	Duration of the audio in seconds
folderId	integer	Identifier of the folder
folder	string	Folder details
progress	double	Progress of the audio processing
estimatedFinishTime	string	Estimated finish time for processing
showEncodingProgress	boolean	Indicates if encoding progress should be shown
errorId	integer	Unique identifier for the error
error	string	Description of the error
highlight	object	Highlight information
resultInfo	string	Returns extra information about the result
statusCode	integer	Returns the HTTP Status Code

info

For more information about the possible errorId and error values, see Error Codes.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed